NZPost.AddressChecker

Resource URL

UAT:

http://api.uat.nzpost.co.nz/addresschecker/1.0/details

Production:

https://api.nzpost.co.nz/addresschecker/1.0/details

Resource Description

Takes an address dpid, and returns detailed information about the matching address.

Resource Information

Attribute	Detail
Response Format	JSON
Requires Authentication	Yes
Rate Limited	15 calls per second. If rate limit is exceeded, calls will be queued. Calls unprocessed for over 60 seconds will time out.

Please note that all request parameters should be in lower case.

Request Parameters

Field Name	Description	Value	Required	Example
dpid	The delivery point identifier.	String	Yes	109570

Sample Request

https://api.nzpost.co.nz/addresschecker/1.0/details?dpid=109570

Response Parameters

Field Name	Description	Value	Required	Example
success	Indicates if the request succeeded or not.	Boolean	Yes	true
details	Details of the requested address.	Array	Yes if success = true	See Details Object below
status	Status of the request.	String	Yes	success

Details Object

Field Name	Description	Value	Example
DPID	Unique NZ Post identifier.	Integer	109570
AddressLine1	Address Lines 1-5 are formatted: as they would appear on a mail item. to meet the Address Layout Standards.	String	8 Water Lane
AddressLine2		String	New Plymouth 4310
AddressLine3		String	null
AddressLine4		String	null
AddressLine5		String	null
Postcode	NZ Post code used for defining an area	String	4310
NZTMCoord	Contains coordinate information for a point in NZTM format. Contains the following keys: "type" "crs" "coordinates"	GeoJSON Point	See Sample Response below
NZGD2kCoord	Contains coordinate information for a point in NZGD2k format. Contains the following keys: "type" "crs" "coordinates"	GeoJSON Point	See Sample Response below
NZMGCoord	Contains coordinate information for a point in NZMG format. Contains the following keys: "type" "crs" "coordinates"	GeoJSON Point	See Sample Response below
Meshblock	Geographic Area	String	1591000
StatsCensusYear	Year the census was taken	Integer	2013
SourceDesc	Address Reference Dataset source category text.	String	Postal\\\Physical
Deliverable	Y/N. Indicates if the address has mail delivery. NOTE: A rural postal address is not valid if this flag = "N"	String	Y
Physical	Y/N. Indicates if the address is a physical address.	String	Y
UnitType	Type of unit	String	"FLAT" in the case of "FLAT 3 10 Smith Street"
UnitValue	Unit number	String	"3" in the case of "FLAT 3 10 Smith Street"
Floor	Floor number	String	"Floor 5" in "Floor 5 10 Smith Street"
StreetNumber	Street number	Integer	"10" in the case of "10A Smith Street"
StreetAlpha	Street alpha	String	"A" in the case of "10A Smith Street"
RoadName	Street name. The name of the street / road, including prefix.	String	Water
RoadTypeName	Street type	String	Lane
RoadSuffixName	Street direction. Directional suffix details after Road.	String	e.g. "West"
Suburb	Suburb name	String	New Plymouth
RuralDelivery	Rural delivery number (Postal only) for rural addresses.	String	null
Lobby	Delivery Service Name (Box Lobby or PostCentre). Lobby name (for Box/Bag addresses)	String	null
CityTown	The name of the town or city	String	New Plymouth
MailTown	Rural Delivery Distribution Centre. Rural mailtown name (Postal only).	String	null
BoxBagNumber	Delivery Service Number. Number of the box or bag.	String	null
BoxBagType	Type of delivery service.	String	e.g. "Box/Bag", "PO Box", "Private Bag", "Counter Delivery", "Community Mailbox"
ParcelId		Integer	4655740
DeliveredOnMonday	True if mail is delivered on that day. False if mail is not delivered on that day.	Boolean	true
DeliveredOnTuesday		Boolean	false
DeliveredOnWednesday		Boolean	true
DeliveredOnThursday		Boolean	false
DeliveredOnFriday		Boolean	true
DeliveredOnSaturday		Boolean	false
DeliveredOnSunday		Boolean	false
CourierRound		String	TCP009

Sample Response